Create comprehensive CLAUDE.md for AI assistant guidance#1
Create comprehensive CLAUDE.md for AI assistant guidance#1JestingDart4369 merged 1 commit intomainfrom
Conversation
Add detailed documentation covering project structure, architecture, coding conventions, configuration options, and common development tasks to help AI assistants work effectively with the codebase. https://claude.ai/code/session_01P1SCPfCt8u8mVZ5yE4tKUi
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation (CLAUDE.md) for AI assistants to understand and work with the Python_Panel codebase. The document covers project structure, architecture, configuration, coding conventions, and common development tasks.
Changes:
- Added CLAUDE.md with detailed guidance on project structure, data flow, and service architecture
- Documented configuration options, API requirements, and available themes
- Included coding conventions, common development tasks, and security best practices
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| | Option | Type | Default | Description | | ||
| |--------|------|---------|-------------| | ||
| | `theme` | string | `"autumn"` | UI theme (forest_dark, forest, autumn, glacier, midnight_olive) | | ||
| | `refresh_minutes` | int | `10` | Data refresh interval (min 10 seconds enforced) | |
There was a problem hiding this comment.
The description "min 10 seconds enforced" is unclear. Based on the code in app/main.py:29, the actual behavior is that refresh_minutes is converted to seconds and then a minimum of 10 seconds is enforced on the refresh interval. Consider clarifying this as "Minimum refresh interval is 10 seconds regardless of configured value".
| | `refresh_minutes` | int | `10` | Data refresh interval (min 10 seconds enforced) | | |
| | `refresh_minutes` | int | `10` | Data refresh interval in minutes (minimum refresh interval is 10 seconds regardless of configured value) | |
| | `refresh_minutes` | int | `10` | Data refresh interval (min 10 seconds enforced) | | ||
| | `units` | string | `"metric"` | Temperature/wind units (metric or imperial) | | ||
| | `use_winrt_location` | bool | `true` | Enable Windows native geolocation | | ||
| | `live_screen` | bool | `true` | Enable Rich Live screen mode | |
There was a problem hiding this comment.
The documented default value for "live_screen" is true, but the actual default in the codebase is False (app/config.py:38). Please update the documentation to reflect the correct default value.
|
|
||
| | Option | Type | Default | Description | | ||
| |--------|------|---------|-------------| | ||
| | `theme` | string | `"autumn"` | UI theme (forest_dark, forest, autumn, glacier, midnight_olive) | |
There was a problem hiding this comment.
The documented default value for the "theme" option is "autumn", but the actual default in the codebase is "classic" (app/config.py:29). Additionally, there is no "classic" theme defined in the STYLES dictionary (app/ui/theme.py:8-191), which would cause the application to fail when using the default configuration. Consider updating the documentation to match the actual default or changing the default in config.py to "autumn".
| | Option | Type | Default | Description | | ||
| |--------|------|---------|-------------| | ||
| | `theme` | string | `"autumn"` | UI theme (forest_dark, forest, autumn, glacier, midnight_olive) | | ||
| | `refresh_minutes` | int | `10` | Data refresh interval (min 10 seconds enforced) | |
There was a problem hiding this comment.
The documented default value for "refresh_minutes" is 10, but the actual default in the codebase is 15 (app/config.py:30). Please update the documentation to reflect the correct default value.
2 participants
Add detailed documentation covering project structure, architecture,
coding conventions, configuration options, and common development tasks
to help AI assistants work effectively with the codebase.
https://claude.ai/code/session_01P1SCPfCt8u8mVZ5yE4tKUi